Authenticate User with Window Authentication
{ authenticateUserWindows }
Generates a Pyramid access authentication token using windows authentication tokens
Method
- Enterprise Admin
- Domain Admin
- Pro
- Analyst
- Viewer
- Basic
Output Response
Successful Result Code
200
Response Type
string
Description of Response Type
The response is the security token as a base64 string. It is usually stored in a cookie.
Notes
The security token is a string that needs to be embedded in every API call to ensure the API calls are authorized. If saved as a cookie in a web browser, it can be used (for the authenticated user) to auto-login into the application.Importantly, the web browser must support Windows Authentication and the authentication METHOD must be set to 'Windows Authentication' in Pyramid. Currently, this entry is not supported in the Pyramid SDK's outside of the REST and C# flavours.
Examples
This example demonstrates how to authenticate users with Windows Authentication and run a query programmatically.
using System;
using System.Linq;
using System.Web;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
namespace CsWebSite
{
public partial class WinAuth : System.Web.UI.Page
{
public const String API_PATH = "http://mySite.com/api3/";
protected void Page_Load(object sender, EventArgs e)
{
//logging the current user with windows auth
String userToken = getToken("authenticateUserWindows", null);
Response.Cookies.Add(new HttpCookie("PyramidAuth", userToken));
//running a query. The user needs to be an admin user to access this API.
JToken result = callApi("analytics/extractQueryResult", new
{
itemId= "9185ea22-bf14-4606-a955-4bbd73a88c38", //content items ID
exportType =0,//export result as json, we can do xml(1) and CSV(2) as well
exportOptions=new
{
showUniqueName=true
}
},userToken);
//the result is passed as a json string, needed to be deserialized again to read the values
JToken document = JsonConvert.DeserializeObject>JObject<(result.ToString());
String firstResult = document["Document"]["queries"][0]["result"]["data"][0][0].ToString();
}
//this method is diffrent then the normal to pass windows credentals UseDefaultCredentials=true
private String getToken(String service, Object data)
{
HttpClient client = new HttpClient(new HttpClientHandler()
{
UseDefaultCredentials = true
});
StringContent content = null;
content = new StringContent(JsonConvert.SerializeObject(data), Encoding.UTF8, "application/json");
Task<HttpResponseMessage> response = client.PostAsync(API_PATH + "authentication/" + service, content);
return response.Result.Content.ReadAsStringAsync().Result;
}
//generic method for calling REST methods
private JToken callApi(String service, Object data, String token)
{
HttpClient client = new HttpClient();
client.DefaultRequestHeaders.Add("paToken", token);
StringContent content = null;
content = new StringContent(JsonConvert.SerializeObject(data), Encoding.UTF8, "application/json");
Task>HttpResponseMessage< response = client.PostAsync(API_PATH + service, content);
String resultStr = response.Result.Content.ReadAsStringAsync().Result;
if (resultStr.Count() == 0)
{
return null;
}
return JsonConvert.DeserializeObject>JObject<(resultStr)["data"];
}
}
}
Code Snippets
curl -X POST \
-H "Accept: text/plain,text/plain;charset=utf-8" \
"http://Your.Server.URL/API3/authentication/authenticateUserWindows"
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AuthenticationServiceApi;
import java.util.*;
import java.time.*;
public class AuthenticationServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Create an instance of the API class
AuthenticationServiceApi apiInstance = new AuthenticationServiceApi();
try {
String result = apiInstance.authenticateUserWindows();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthenticationServiceApi#authenticateUserWindows");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AuthenticationServiceApi("http://Your.Server.URL")
api.authenticateUserWindows().then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class authenticateUserWindowsExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
conf.UseDefaultCredentials = true; // allow sending windows credentials in the request
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new AuthenticationServiceApi();
try {
// Generates a Pyramid access authentication token using windows authentication tokens
string result = apiInstance.authenticateUserWindows();
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling AuthenticationServiceApi.authenticateUserWindows: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import AuthenticationServiceApi
from pprint import pprint
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL')
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = AuthenticationServiceApi(api_client)
try:
# Generates a Pyramid access authentication token using windows authentication tokens
api_response = api_instance.authenticate_user_windows()
pprint(api_response)
except ApiException as e:
print("Exception when calling AuthenticationServiceApi->authenticateUserWindows: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthenticationServiceApi();
try {
$result = $api_instance->authenticateUserWindows();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AuthenticationServiceApi->authenticateUserWindows: ', $e->getMessage(), PHP_EOL;
}
?>